/*
 * Copyright (c) 1994, 2013, Oracle and/or its affiliates. All rights reserved.
 * ORACLE PROPRIETARY/CONFIDENTIAL. Use is subject to license terms.
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 */

package java.io;

import java.nio.channels.FileChannel;
import sun.nio.ch.FileChannelImpl;


/**
 * FileInputStream从文件系统中的文件中获取输入字节。
 * 可用的文件取决于主机环境。
 *
 * <p>FileInputStream用于读取原始字节流，比如图像数据。
 * 对于读取字符流，可以考虑使用FileReader。
 *
 * @author  Arthur van Hoff
 * @see     java.io.File
 * @see     java.io.FileDescriptor
 * @see     java.io.FileOutputStream
 * @see     java.nio.file.Files#newInputStream
 * @since   JDK1.0
 */
public
class FileInputStream extends InputStream
{
    /* File Descriptor - 用于打开文件 */
    private final FileDescriptor fd;

    /**
     * 引用文件的路径
     * （如果流通过file descriptor创建，为null）
     */
    private final String path;

    private FileChannel channel = null;

    /**
     * closeLock，关闭时，以它进行synchronize
     */
    private final Object closeLock = new Object();
    
    /**
     * 流是否关闭
     */
    private volatile boolean closed = false;

    /**
     * 通过打开一个到实际文件的连接来创建一个FileInputStream，
     * 该文件由文件系统的路径名为name命名。
     * 创建一个新的FileDescriptor对象来表示这个文件连接。
     * <p>
     * 首先，如果有一个security manager，
     * 它的checkRead方法将以参数name作为它的参数来调用。
     * <p>
     * 如果指定的文件不存在，是一个目录而不是一个常规文件，
     * 或者由于某些其他原因无法打开读取，则会抛出FileNotFoundException。
     *
     * @param      name   依赖于系统的文件名称
     * @exception  FileNotFoundException  if the file does not exist,
     *                   is a directory rather than a regular file,
     *                   or for some other reason cannot be opened for
     *                   reading.
     * @exception  SecurityException      并且它的checkRead方法拒绝对文件的访问
     * @see        java.lang.SecurityManager#checkRead(java.lang.String)
     */
    public FileInputStream(String name) throws FileNotFoundException {
    	// 调用 FileInputStream(File file) 构造函数
        this(name != null ? new File(name) : null);
    }

    /**
     * 通过打开一个到实际文件的连接来创建一个FileInputStream，
     * 该文件由文件系统的路径名为name命名。
     * 创建一个新的FileDescriptor对象来表示这个文件连接。
     * <p>
     * 首先，如果有一个security manager，
     * 它的checkRead方法将以参数name作为它的参数来调用。
     * <p>
     * 如果指定的文件不存在，是一个目录而不是一个常规文件，
     * 或者由于某些其他原因无法打开读取，则会抛出FileNotFoundException。
     *
     * @param      file   the file to be opened for reading.
     * @exception  FileNotFoundException  if the file does not exist,
     *                   is a directory rather than a regular file,
     *                   or for some other reason cannot be opened for
     *                   reading.
     * @exception  SecurityException      if a security manager exists and its
     *               <code>checkRead</code> method denies read access to the file.
     * @see        java.io.File#getPath()
     * @see        java.lang.SecurityManager#checkRead(java.lang.String)
     */
    public FileInputStream(File file) throws FileNotFoundException {
        String name = (file != null ? file.getPath() : null);
        SecurityManager security = System.getSecurityManager();
        if (security != null) {
            security.checkRead(name);
        }
        if (name == null) {
            throw new NullPointerException();
        }
        if (file.isInvalid()) {
            throw new FileNotFoundException("Invalid file path");
        }
        // 创建一个新的FileDescriptor，赋值给fd，fd与这个FileInputStream进行关联
        fd = new FileDescriptor();
        fd.attach(this);
        // 赋值给path，调用open方法，注意这其实是本地方法，进行读取文件
        path = name;
        open(name);
    }

    /**
     * 使用文件描述符fdObj创建FileInputStream，
     * 该描述符表示与文件系统中实际文件的现有连接。
     * <p>
     * 如果存在安全管理器，则调用其checkRead方法，
     * 并将文件描述符fdObj作为参数，以确定是否可以读取文件描述符。
     * 如果对文件描述符的读访问被拒绝，则抛出SecurityException。
     * <p>
     * 如果fdObj为null，抛出NullPointerException
     * <p>
     * 如果fdObj无效，此构造函数不会抛出异常。
     * 但是，如果试图对流进行IO操作，则会抛出一个IOException。
     *
     * @param      fdObj   the file descriptor to be opened for reading.
     * @throws     SecurityException      if a security manager exists and its
     *                 <code>checkRead</code> method denies read access to the
     *                 file descriptor.
     * @see        SecurityManager#checkRead(java.io.FileDescriptor)
     */
    public FileInputStream(FileDescriptor fdObj) {
        SecurityManager security = System.getSecurityManager();
        if (fdObj == null) {
            throw new NullPointerException();
        }
        if (security != null) {
            security.checkRead(fdObj);
        }
        // 赋值fd，fd与FileInputStream关联，path为null
        fd = fdObj;
        path = null;

        /*
         * FileDescriptor被流共享，把这个流给FileDescriptor追踪器共享
         */
        fd.attach(this);
    }

    /**
     * 打开指定的文件，来读取  本地方法
     * @param name the name of the file
     */
    private native void open0(String name) throws FileNotFoundException;

    // 包装本地调用以允许instrumentation
    /**
     * 打开指定的文件，来读取
     * @param name the name of the file
     */
    private void open(String name) throws FileNotFoundException {
        open0(name);
    }

    /**
     * 从这个输入流中读取一个字节的数据。
     * 如果没有可用的输入，这个方法将被阻塞。
     * 底层是本地方法。
     *
     * @return     the next byte of data, or <code>-1</code> if the end of the
     *             file is reached.
     * @exception  IOException  if an I/O error occurs.
     */
    public int read() throws IOException {
        return read0();
    }

    private native int read0() throws IOException;

    /**
     * 本地方法：以字节序列的形式读取子数组。
     * @param b the data to be written
     * @param off the start offset in the data
     * @param len the number of bytes that are written
     * @exception IOException If an I/O error has occurred.
     */
    private native int readBytes(byte b[], int off, int len) throws IOException;

    /**
     * Reads up to <code>b.length</code> bytes of data from this input
     * stream into an array of bytes. This method blocks until some input
     * is available.
     * 
     * 从这个inputstream中读取最多b.length字节的数据到一个字节数组中。
     * 此方法将阻塞，直到有一些输入可用。
     *
     * @param      b   the buffer into which the data is read.
     * @return     the total number of bytes read into the buffer, or
     *             <code>-1</code> if there is no more data because the end of
     *             the file has been reached.
     * @exception  IOException  if an I/O error occurs.
     */
    public int read(byte b[]) throws IOException {
        return readBytes(b, 0, b.length);
    }

    /**
     * 从这个输入中读取最多len字节的数据流成一个字节数组。
     * 如果len不为零，方法阻塞直到一些输入可用;
     * 否则，什么字节都不读取并返回0。
     *
     * @param      b     the buffer into which the data is read.
     * @param      off   the start offset in the destination array <code>b</code>
     * @param      len   the maximum number of bytes read.
     * @return     读入缓存的总字节数，如果遇到文件末尾，返回-1
     * @exception  NullPointerException If <code>b</code> is <code>null</code>.
     * @exception  IndexOutOfBoundsException If <code>off</code> is negative,
     * <code>len</code> is negative, or <code>len</code> is greater than
     * <code>b.length - off</code>
     * @exception  IOException  if an I/O error occurs.
     */
    public int read(byte b[], int off, int len) throws IOException {
        return readBytes(b, off, len);
    }

    /**
     * 从输入流跳过和丢弃n个字节的数据。
     *
     * <p>由于各种原因，skip方法最终可能跳过一些较小的字节数，可能为0。
     * 如果n是负的，该方法将尝试向后跳。
     * 如果后备文件在其当前位置不支持向后跳过，就会抛出IOException。
     * 将返回跳过的实际字节数。如果它跳跃，它返回一个正值。如果它向后跳跃，它返回一个负值。
     *
     * <p>此方法可能跳过比备份文件中剩余的字节更多的字节。
     * 这不会产生任何异常，而且跳过的字节数可能包括一些超出了备份文件的EOF的字节数。
     * 跳过结束后,尝试从流读取,将导致-1,表示文件结束。
     *
     * @param      n   the number of bytes to be skipped.
     * @return     the actual number of bytes skipped.
     * @exception  IOException  if n is negative, if the stream does not
     *             support seek, or if an I/O error occurs.
     */
    public native long skip(long n) throws IOException;

    /**
     * 返回可以从该输入流读取(或跳过)的剩余字节数的估计数，
     * 而不会被该输入流的方法的下一次调用阻塞。
     * 当文件位置超过EOF时返回0。
     * 下一个调用可能是同一个线程或另一个线程。
     * 单个读取或跳过这么多字节不会阻塞，但可能读取或跳过更少的字节。
     *
     * <p> 在某些情况下，非阻塞读(或跳过)可能
     * 仅仅在速度较慢时被阻塞，例如在较慢的网络上读取较大的文件时。
     *
     * @return     an estimate of the number of remaining bytes that can be read
     *             (or skipped over) from this input stream without blocking.
     * @exception  IOException  if this file input stream has been closed by calling
     *             {@code close} or an I/O error occurs.
     */
    public native int available() throws IOException;

    /**
     * 关闭该文件输入流并释放与该流关联的任何系统资源。
     *
     * <p> 如果该流有一个相关联的通道，则同样关闭这个通道。
     *
     * @exception  IOException  if an I/O error occurs.
     *
     * @revised 1.4
     * @spec JSR-51
     */
    public void close() throws IOException {
    	// 使用closeLock进行同步
        synchronized (closeLock) {
        	// closed只赋值一次，进行下面的流程，其余都return
            if (closed) {
                return;
            }
            closed = true;
        }
        // 关闭channel
        if (channel != null) {
           channel.close();
        }
        // 通过文件描述符，进行关闭文件流
        fd.closeAll(new Closeable() {
            public void close() throws IOException {
            	// close0是本地方法
               close0();
           }
        });
    }

    /**
     * 返回FileDescriptor对象，
     * 该对象表示此FileInputStream 与 文件系统中的所使用的实际文件的连接。
     *
     * @return     the file descriptor object associated with this stream.
     * @exception  IOException  if an I/O error occurs.
     * @see        java.io.FileDescriptor
     */
    public final FileDescriptor getFD() throws IOException {
        if (fd != null) {
            return fd;
        }
        throw new IOException();
    }

    /**
     * 返回与此文件输入流关联的惟一FileChannel对象。
     *
     * <p> 返回FileChannel的position()将等于到目前为止从文件中读取的字节数。
     * 从这个流中读取字节将增加通道的位置。
     * 通过显式或读取方式改变通道的位置，将改变流的文件位置。
     *
     * @return  the file channel associated with this file input stream
     *
     * @since 1.4
     * @spec JSR-51
     */
    public FileChannel getChannel() {
        synchronized (this) {
        	// 单例模式，通过fd，path，生成一个channel
            if (channel == null) {
                channel = FileChannelImpl.open(fd, path, true, false, this);
            }
            return channel;
        }
    }

    private static native void initIDs();

    private native void close0() throws IOException;

    static {
        initIDs();
    }

    /**
     * 确保在没有对该文件输入流的更多引用时调用该文件输入流的close方法。
     *
     * @exception  IOException  if an I/O error occurs.
     * @see        java.io.FileInputStream#close()
     */
    protected void finalize() throws IOException {
        if ((fd != null) &&  (fd != FileDescriptor.in)) {
            /* 如果fd是共享的，那么FileDescriptor中的引用
             * 将确保只在安全的情况下调用finalizer。
             * 所有使用fd的引用都变得不可访问。我们可以调用close()
             */
            close();
        }
    }
}
